Skip to content

[CXP-2151] Updates to Processes and Containers documentation #29409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
May 19, 2025

Conversation

kkhor-datadog
Copy link
Contributor

@kkhor-datadog kkhor-datadog commented May 17, 2025

What does this PR do? What is the motivation?

Changes in this PR include:

  • Remove reference to dedicated process agent where appropriate, as process and container collection now runs in the core agent by default on Linux
  • Remove references to deprecated DD_PROCESS_AGENT_ENABLED config, replacing with new configs.
  • Link to recently-released processes custom tagging functionality where appropriate
  • Various grammatical and spelling fixes

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

If your branch doesn't follow this format, rename it or create a new branch and PR.

To have your PR automatically merged after it receives the required reviews, add the following PR comment:

/merge

Additional notes

```

Then, upgrade your Helm chart.

In some setups, the Process Agent and Cluster Agent cannot automatically detect a Kubernetes cluster name. If this happens, the feature does not start, and the following warning displays in the Cluster Agent log: `Orchestrator explorer enabled but no cluster name set: disabling.` In this case, you must set `datadog.clusterName` to your cluster name in `values.yaml`.
In some setups, the Cluster Agent cannot automatically detect a Kubernetes cluster name. If this happens, the feature does not start, and the following warning displays in the Cluster Agent log: `Orchestrator explorer enabled but no cluster name set: disabling.` In this case, you must set `datadog.clusterName` to your cluster name in `values.yaml`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove mention of dedicated process agent as container collection functionality no longer runs in process agent by default

@@ -226,7 +229,7 @@ You can see indexed logs that you have chosen to index and persist by selecting

{{< img src="infrastructure/livecontainers/errorlogs.png" alt="Preview Logs Side panel" style="width:100%;">}}

## Notes and known issues
## Additional information
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neither of these seem like issues, so updating the section title to match the one on the Processes page: https://docs.datadoghq.com/infrastructure/process/?tab=linuxwindows#additional-information

@@ -207,7 +207,7 @@ For more information about installing the Datadog Agent with AWS ECS Fargate, se

### I/O stats

I/O and open files stats can be collected by the Datadog system-probe, which runs with elevated privileges. To enable the process module of the system-probe, use the following configuration:
I/O and open files stats can be collected by the Datadog system-probe, which runs with elevated privileges. To collect these stats, use the following configuration to enable the process module of the system-probe:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some clarification here that enabling the process module enables I/O stats collection, as otherwise it seemed a bit disjointed

@@ -39,11 +39,11 @@ You can generate a new process-based metric directly from queries in the [**Live

{{< img src="infrastructure/process/process2metrics_create.png" alt="Create a process-based metric" style="width:80%;">}}

1. **Select tags to filter your query**: The query syntax is the same as for [Live Processes][2]. Only processes matching the scope of your filters are considered for aggregation. Text search filters are supported only on the Live Processes page.
1. **Select tags to filter your query**: The available tags are the same as for [Live Processes][2]. Only processes matching the scope of your filters are considered for aggregation. Text search filters are supported only on the Live Processes page.
Copy link
Contributor Author

@kkhor-datadog kkhor-datadog May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The query syntax is not the same. Boolean operators are not supported here, unlike in the Processes page.

@kkhor-datadog kkhor-datadog changed the title Kkhor/processes update [CXP-2151] Updates to Processes and Containers documentation May 19, 2025
@kkhor-datadog kkhor-datadog marked this pull request as ready for review May 19, 2025 16:29
@kkhor-datadog kkhor-datadog requested a review from a team as a code owner May 19, 2025 16:29
Copy link
Contributor

@domalessi domalessi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few nits! Let me know when ready for final review/approval :)

@@ -491,7 +494,7 @@ You can customize integration views (for example, when aggregating a query for N

## Processes across the platform

### Live containers
### Live Containers
Copy link
Contributor

@domalessi domalessi May 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Original was actually correct - we follow sentence casing for headers!

Suggested change
### Live Containers
### Live Containers

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine following the preferred style so I reapplied this change, however I will note that this is inconsistent with the Cloud Network Monitoring header:
image

kkhor-datadog and others added 2 commits May 19, 2025 13:56
live containers back to upper case
@domalessi
Copy link
Contributor

/merge

@dd-devflow
Copy link

dd-devflow bot commented May 19, 2025

View all feedbacks in Devflow UI.

2025-05-19 20:48:07 UTC ℹ️ Start processing command /merge


2025-05-19 20:48:14 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2025-05-19 21:18:13 UTC ℹ️ MergeQueue: merge request added to the queue

The expected merge time in master is approximately 21m (p90).


2025-05-19 21:34:59 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 67f487a into master May 19, 2025
19 of 21 checks passed
@dd-mergequeue dd-mergequeue bot deleted the kkhor/processes-update branch May 19, 2025 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants